# Программа для генерации описания файлов по комментариям.
Программа считывает специальные комментарии в начале файлов директории, и генерирует README,
с их описаниями.

## Зачем эта программа нужна
Допустим, у нас есть папка src:
--src
 - main.zig
 - read.zig
 - eval.zig
 - print.zig
Разработчику хорошо было бы знать, что в каком файле лежит, и для чего каждый из них нужен.
Но открывать каждый файл, и уж тем более читать код, довольно тяжело, а по названию не всегда
всё понятно. Особенно это касается тех, кто не знает кодовую базу, а прищёл и смотрит проект
на GitHub.

Решение - создавать в папке с кодом файл README, в котором будут даны краткие описания файлов.

Чтобы было ещё удобнее, можно писать это описание в самом начале файла, думаю, тогда будет
несколько удобннее редактировать его - не придётся открывать лишний файл, думать о синхронизации.

Поместить описание можно в специальный комментарий. Этот комментарий будет использован нашей программой
для того, чтобы сгенерировать README файл.

## Команды
Программа запускается и командной строки.
На данный момент я могу придумать следующие команды, или скорее опции.
Самые главные следующие:
* gen - просматривает файлы, считывает документационный комментарий (если он есть) из каждого,
  генерирует файл README.
* check - проверяет, что во всех файлах данной директории есть документационной комментарий.
  По специальному ключу можно получить список всех неиспользованных файлов.
* add - открывает текстовый редактор, в котором можно создать README, добавить комментарий к каждому
  файлу, к одному за другим
* config - конфигурирует программу. Чтобы всё было просто, можно открывать редактор с конфигом.
* tutorial - запускает туториал.
* help - выдаёт справку.
* donat - выдаёт страницу для доната.

## Формат документирующих комментариев
Чтобы генерировать README, нам нужно взять описание файла из специального комментария.
Вопрос в том, как составить этот комментарий.
TODO: посмотреть, какими бывают комментарии в крупных проектах.
